Close
dtSearch Engine API for .NET Framework 2.x-4.x 2024.01
WordListBuilder::ListFieldValues Method

List all field values in the index that match an expression

public long ListFieldValues( ref String Field, ref String toMatch, long nLimit );
Parameters
Description
toMatch
The expression to match
nLimit
Maximum number of words to find
field
The field to enumerate (the field must have been designated as an EnumerableField when the index was built)

Number of words found.

The maximum amount of text that can be stored in each stored field is the lesser of the MaxStoredFieldSize option setting or 127 characters, including the field name. 

A SearchFilter can be used with ListFieldValues to limit the results to values in a set of documents. Use SetFilter to attach a SearchFilter to the WordListBuilder

When a SearchFilter is used, all counts returned by WordListBuilder are document counts. For example, if a word occurs 20 times in 7 documents, the count returned will be 7 for both GetNthWordCount and GetNthWordDocCount.